From 8173ff9b4f0a80c39f14c80a2bb4b19d9a499ad3 Mon Sep 17 00:00:00 2001 From: =?utf8?q?=C3=98yvind=20Kol=C3=A5s?= Date: Fri, 9 Sep 2005 11:13:30 +0000 Subject: [PATCH] documentation updates --- ChangeLog | 6 ++++++ docs/Makefile.am | 4 ++-- docs/index-static.html.in | 20 +++++++------------- 3 files changed, 15 insertions(+), 15 deletions(-) diff --git a/ChangeLog b/ChangeLog index 60a9ea7..d24b9ff 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,9 @@ +2005-09-09 Øyvind Kolås + + * docs/Makefile.am: set BABL_PATH to builddir for creating the + documentation + * docs/index-static.html.in: various updates. + 2005-09-09 Øyvind Kolås * babl/base/type-u16.c: (convert_double_u16_scaled): diff --git a/docs/Makefile.am b/docs/Makefile.am index bf538b6..a91b2b1 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -28,11 +28,11 @@ all: $(HTML_FILES) -index.html: index-static.html $(top_builddir)/tests/babl_html_dump $(top_srcdir)/AUTHORS $(top_srcdir)/NEWS +index.html: index-static.html $(top_builddir)/tests/babl_html_dump $(top_srcdir)/AUTHORS $(top_srcdir)/NEWS $(top_srcdir)/extensions/*.so Makefile.am echo -n "HTML: $@" cp $< $@ (TMPFILE=`tempfile`;\ - $(top_builddir)/tests/babl_html_dump > $$TMPFILE;\ + export BABL_PATH="$(top_builddir)/extensions"; $(top_builddir)/tests/babl_html_dump > $$TMPFILE;\ $(top_srcdir)/docs/tools/xml_insert.sh $@ BablBase $$TMPFILE;\ rm -f $$TMPFILE ) diff --git a/docs/index-static.html.in b/docs/index-static.html.in index ff707ef..a318276 100644 --- a/docs/index-static.html.in +++ b/docs/index-static.html.in @@ -174,18 +174,18 @@ pixel_count);

If the existing pixel formats are not sufficient for your conversion - needs, new ones can be created and named on the fly. The constructor + needs, new ones can be created on the fly. The constructor will provide the prior created one if duplicates are registered. 

babl_format_new ("bgr-u8",
-                 babl_model ("rgb"),
+>babl_format_new (babl_model ("rgb"),
                  babl_type ("u8"),
                  babl_component ("B"),
                  babl_component ("G"),
                  babl_component ("R"),
                  NULL);
-

Instead of a linear buffer you can an image descriptor which desribes the start of the memory segment, the pitch in bytes between samples, and the rowstride (optionally 0 for unlimited). +

Instead of a linear buffer you can an image descriptor which desribes the start of the memory segment, the pitch in bytes between samples, and the rowstride (not used yet, + use 0 to indicate unlimited for compatibility with future API.) 

babl_process (babl_fish ("srgb", "y'cbcr420p"),
@@ -196,23 +196,17 @@
                           NULL);
-

For more code samples look in the tests directory.

-

Extending

For samples of how the current internal api of specification of - data types, color models, and conversions look in the babl/base/ + data types, color models, and conversions look in the extensions/ directory. The tables in this HTML file is directly generated - based on the data registered by BablBase. The API's used are very + based on the data registered by BablCore (double and RGBA), BablBase (core datatypes, and RGB models), + extensions (CIE Lab, naive CMYK, various shortcut conversions). The API's used are very similar in style to the API's described under the Usage section.

-

For now, the only way to extend babl is from the application - using the library, by structuring your code in a similar fashion - to BablBase it should be easier to later turn it into a loadable - module. -

TODO

-- 2.30.2